<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>class AboutYou::SDK::Model::BasketSetItem - RDoc Documentation</title>

<link href="../../../fonts.css" rel="stylesheet">
<link href="../../../rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../../../";
</script>

<script src="../../../js/jquery.js"></script>
<script src="../../../js/navigation.js"></script>
<script src="../../../js/search_index.js"></script>
<script src="../../../js/search.js"></script>
<script src="../../../js/searcher.js"></script>
<script src="../../../js/darkfish.js"></script>


<body id="top" role="document" class="class">
<nav role="navigation">
  <div id="project-navigation">
    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2>
    <a href="../../../index.html" rel="home">Home</a>
  </h2>

  <div id="table-of-contents-navigation">
    <a href="../../../table_of_contents.html#pages">Pages</a>
    <a href="../../../table_of_contents.html#classes">Classes</a>
    <a href="../../../table_of_contents.html#methods">Methods</a>
  </div>
</div>

    <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

  </div>

  

  <div id="class-metadata">
    
    <div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  
  <p class="link">Object
  
</div>

    <div id="includes-section" class="nav-section">
  <h3>Included Modules</h3>

  <ul class="link-list">
  
  
    <li><a class="include" href="BasketVariantItem.html">AboutYou::SDK::Model::BasketVariantItem</a>
  
  
  </ul>
</div>

    
    <!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    
    <li ><a href="#method-i-create_from_json">#create_from_json</a>
    
  </ul>
</div>

  </div>
</nav>

<main role="main" aria-labelledby="class-AboutYou::SDK::Model::BasketSetItem">
  <h1 id="class-AboutYou::SDK::Model::BasketSetItem" class="class">
    class AboutYou::SDK::Model::BasketSetItem
  </h1>

  <section class="description">
    
<p><a href="BasketSetItem.html">BasketSetItem</a> is a class used for adding a
variant set item into the basket</p>

  </section>

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    
    <section class="constants-list">
      <header>
        <h3>Constants</h3>
      </header>
      <dl>
      
        <dt id="ERROR_CODE_PRODUCT_NOT_INCLUDED">ERROR_CODE_PRODUCT_NOT_INCLUDED
        
        <dd><p>erorr code if a product is not included</p>
        
      
      </dl>
    </section>
    

    

    
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Instance Methods</h3>
       </header>

    
      <div id="method-i-create_from_json" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">create_from_json</span><span
            class="method-args">(json_object, products)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>This method is used for creating a basket set item from a given api json
response. It is best practice to use this method.</p>
<ul><li>
<p><strong>Args</strong>    :</p>
<ul><li>
<p><code>json_object</code> -&gt; the api response key</p>
</li><li>
<p><code>products</code> -&gt; Array of products</p>
</li></ul>
</li><li>
<p><strong>Returns</strong> :</p>
<ul><li>
<p>an instance of <a
href="BasketSetItem.html">AboutYou::SDK::Model::BasketSetItem</a></p>
</li></ul>
</li></ul>
          
          

          
          <div class="method-source-code" id="create_from_json-source">
            <pre><span class="ruby-comment"># File lib/AboutYou/Model/Basket/basket_set_item.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">create_from_json</span>(<span class="ruby-identifier">json_object</span>, <span class="ruby-identifier">products</span>)
  <span class="ruby-identifier">item</span> = <span class="ruby-identifier">new</span>(
    <span class="ruby-identifier">json_object</span>[<span class="ruby-string">'variant_id'</span>],
    <span class="ruby-keyword">if</span> <span class="ruby-identifier">json_object</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">'additional_data'</span>)
      [<span class="ruby-identifier">json_object</span>[<span class="ruby-string">'additional_data'</span>]]
    <span class="ruby-keyword">else</span>
      <span class="ruby-keyword">nil</span>
    <span class="ruby-keyword">end</span>,
    <span class="ruby-identifier">json_object</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">'app_id'</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">json_object</span>[<span class="ruby-string">'app_id'</span>] <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
  )

  <span class="ruby-identifier">item</span>.<span class="ruby-identifier">parse_error_result</span>(<span class="ruby-identifier">json_object</span>)
  <span class="ruby-identifier">item</span>.<span class="ruby-identifier">json_object</span> = <span class="ruby-identifier">json_object</span>

  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">json_object</span>[<span class="ruby-string">'product_id'</span>].<span class="ruby-identifier">nil?</span>
    <span class="ruby-keyword">if</span> <span class="ruby-identifier">products</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">json_object</span>[<span class="ruby-string">'product_id'</span>])
      <span class="ruby-identifier">item</span>.<span class="ruby-identifier">product</span> = <span class="ruby-identifier">products</span>[<span class="ruby-identifier">json_object</span>[<span class="ruby-string">'product_id'</span>]]
    <span class="ruby-keyword">else</span>
      <span class="ruby-identifier">item</span>.<span class="ruby-identifier">errorCode</span>    = <span class="ruby-constant">ERROR_CODE_PRODUCT_NOT_INCLUDED</span>
      <span class="ruby-identifier">item</span>.<span class="ruby-identifier">errorMessage</span> = <span class="ruby-string">'Product with ID '</span> <span class="ruby-operator">+</span>
        <span class="ruby-identifier">json_object</span>[<span class="ruby-string">'product_id'</span>] <span class="ruby-operator">+</span> <span class="ruby-string">' expected but wasnt received
        with the basket'</span>
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-identifier">item</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
    </section>
  
  </section>
</main>


<footer id="validator-badges" role="contentinfo">
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.2.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

